Skip to main content

Update Plan​

Update the details of an existing subscription plan

POST https://api.spotflow.co/api/v1/plans/:plan-id

Headers​

authorization
String

Bearer SECRET_KEY
Include your secret key in the request header as a Bearer token for authorization. Unauthorized requests will result in a 401 HTTP status code.

content-type
String		application/json

Path Parameters​

plan-id int32

This is the unique ID of the subscription plan you want to update.

Body Parameters​

title
String

Name/Title of plan

amount
Integer		Amount should be in the subunit of our supported currency i.e your local currency or USD.
currency
String		Select the currency for the charges. Can either be in USD or in the local currency of your collection region.

Sample Response before Update​

200 OK 

{
    "id": "18a60cb1-02c3-48be-bb7e-53b80e3e183a",
    "title": "FitClock",
    "frequency": "DAILY",
    "internalReference": "fit-clock",
    "status": "active",
    "regions": [
        "Ghana",
        "Nigeria"
    ],
    "subscribers": 1,
    "subscriptions": 1,
    "createdAt": "2025-03-20T15:06:22Z",
    "pricingOptions": [
        {
            "amount": 500,
            "currency": "NGN"
        },
        {
            "amount": 5,
            "currency": "GHS"
        }
    ]
}

Sample Request Body for Update​

{
    "title": "Fitness Plus",
    "frequency": "weekly",
    "internalReference": "ref-fitnessproduct",
    "pricingOptions": [
        {
            "amount": 1000,
            "currency": "NGN"
        },
        {
            "amount": 5,
            "currency": "GHS"
        }
    ]
}

Sample Response after Update​

200 OK 

{
    "id": "18a60cb1-02c3-48be-bb7e-53b80e3e183a",
    "title": "Fitness Plus",
    "frequency": "WEEKLY",
    "internalReference": "ref-fitnessproduct",
    "status": "active",
    "regions": [
        "Ghana",
        "Nigeria"
    ],
    "subscribers": 1,
    "subscriptions": 1,
    "createdAt": "2025-03-20T15:06:22Z",
    "pricingOptions": [
        {
            "amount": 1000,
            "currency": "NGN"
        },
        {
            "amount": 5,
            "currency": "GHS"
        }
    ]
}